Report design parameters

In addition to the reporting entity tags that represent the data for the report content, you can use report design parameters to display additional general information in a report. You do this by including the report design parameters in the report design XML file.

Review a list of reporting entities in the Navis N4: Reference Guide, or in the online help or on the Kaleris Community Portal.

The structure of the report design XML files must follow the DTD (Document Type Definition) of JasperReports. We recommend using a tool called iReport (http://ireport.sourceforge.net/) to create and edit the report design XML files. For more information on N4 and JasperReports compatibility, see the N4 and JasperReports Compatibility Matrix (on page 1).

The following table lists the name, data type, and description of the available report design parameters:

Name

Data Type

Description

Date

Date

Displays the date when the report was created.

The date is localized for the time zone of the user who created the report.

NavisLogo

String

Displays the Navis N4 logo in reports.

Operator

String

Displays the operator in the scope level at which the user who runs the report is logged in.

ReportParams

String

Displays the report parameter labels and the values entered when a report is run.

The report parameters are the filter parameters that you define as part of the report design and report definition filters.

If you do not specify a value for a report parameter at runtime, the report parameter label and value pair is ignored when the report is run.

TimeZone

String

Displays the time zone of the user running the report.

Title

String

Displays the report title as specified in the Report Display Title field in the Report Definition form (on page 1).

If the Report Display Title is not specified, N4 displays null value in the report.

UserId

String

Displays the ID of the user who created the report.

UserScope

String

Displays the login scope of the user who created the report.

When creating the report design XML file, you must type the name of a report design parameter exactly as specified in the above table.